﻿/*
   Copyright 2012 Dmitry Bratus

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Flower.Workflow
{
    /// <summary>
    /// Specifies a path of a workflow under '/Workflows' folder.
    /// 
    /// For example, for a workflow class named 'MyWorkflow' path values will give 
    /// the following global paths:
    /// 
    /// '' (default) : '/Workflows/MyWorkflow'
    /// 'MySystem' : '/Workflows/MySystem/MyWorkflow'
    /// 'MySystem/MySubsystem' : '/Workflows/MySystem/MySubsystem/MyWorkflow'
    /// </summary>
    [AttributeUsage(AttributeTargets.Class)]
    public sealed class PathAttribute : Attribute
    {
        private readonly string _path;

        /// <summary>
        /// The path under '/Workflows' folder.
        /// </summary>
        public string Path { get { return _path; } }

        /// <summary>
        /// Constructs the attribute.
        /// </summary>
        /// <param name="path">The path under '/Workflows' folder.</param>
        public PathAttribute(string path)
        {
            _path = path;
        }
    }
}
